This file contains API for Ultrasonic 3 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"
#include "spi_specifics.h"
#include "drv_pwm.h"

Data Structures
struct	ultrasonic3_t
	Ultrasonic 3 Click context object. More...
struct	ultrasonic3_cfg_t
	Ultrasonic 3 Click configuration object. More...

Macros
#define	ULTRASONIC3_PWM_DEF_FREQ 32767
	Ultrasonic 3 default PWM frequency.
#define	ULTRASONIC3_PWM_DEF_DC 0.5
#define	ULTRASONIC3_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
	Data sample selection.
#define	ULTRASONIC3_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
#define	ULTRASONIC3_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	ultrasonic3_return_value_t { ULTRASONIC3_OK = 0 , ULTRASONIC3_ERROR = -1 }
	Ultrasonic 3 Click return value data. More...

Functions
void	ultrasonic3_cfg_setup (ultrasonic3_cfg_t *cfg)
	Ultrasonic 3 configuration object setup function.
err_t	ultrasonic3_init (ultrasonic3_t ctx, ultrasonic3_cfg_t cfg)
	Ultrasonic 3 initialization function.
err_t	ultrasonic3_default_cfg (ultrasonic3_t *ctx)
	Ultrasonic 3 default configuration function.
err_t	ultrasonic3_set_duty_cycle (ultrasonic3_t *ctx, float duty_cycle)
	Ultrasonic 3 sets PWM duty cycle.
err_t	ultrasonic3_pwm_stop (ultrasonic3_t *ctx)
	Ultrasonic 3 stop PWM module.
err_t	ultrasonic3_pwm_start (ultrasonic3_t *ctx)
	Ultrasonic 3 start PWM module.
void	ultrasonic3_get_measurements (void)
	Ultrasonic 3 get measurements function.

Detailed Description

This file contains API for Ultrasonic 3 Click Driver.

Enumeration Type Documentation

Ultrasonic 3 Click return value data.

Predefined enum values for driver return values.

Enumerator
ULTRASONIC3_OK
ULTRASONIC3_ERROR